Detail Automatic Backup Config

This API returns the current automatic backup configuration, including its scope, destination, schedule, retention, and status.

Endpoint Details

URL	/v1/backup/config
Method	GET
Authorization	Bearer Token

---

Request Headers

Header	Type	Description
Content-Type	String	Must be application/json

---

Response

Here is an example response after the request has been successfully processed:

Response

{
    "data": {
        "id": "49b51474-8bfb-4762-937c-144ccadb72d6",
        "scopes": [
            1,
            2,
            3,
            4
        ],
        "destination_type": 1,
        "destination_path": "/tmp/backups/",
        "schedule": {
            "schedule_type": 1,
            "time": "10:00"
        },
        "retention_days": 7,
        "is_enabled": true,
        "created_at": 1779332170,
        "updated_at": 1784616261,
        "last_run_at": 1784602800,
        "next_run_at": -62135596800,
        "created_by": "0a937c60-0ed4-4d06-870a-2e284b54287d",
        "created_by_name": "Admin Aplikasi",
        "encryption_key": "Q5AjARpdOecvFP6CH4HCAlks+OeB7oQr1mpRLDN6YUs=",
        "s3_config": {}
    }
}

---

Field Descriptions

Field	Type	Description
id	UUID	Unique identifier of the backup configuration
scopes	Array	List of scope codes included in the backup
destination_type	Integer	Type of backup destination
destination_path	String	Path where the backup files are stored
schedule	Object	Schedule configuration for the automatic backup
schedule.schedule_type	Integer	Type of schedule used for the automatic backup
schedule.time	String	Time of day the backup runs (HH:MM)
schedule.weekly_days	Array	Days of the week the backup runs, used when schedule_type is weekly
schedule.monthly_dates	Array	Dates of the month the backup runs, used when schedule_type is monthly
retention_days	Integer	Number of days backups are retained before removal
is_enabled	Boolean	Indicates whether the automatic backup is enabled
created_at	Integer	Creation timestamp in Unix format
updated_at	Integer	Last update timestamp in Unix format
last_run_at	Integer	Timestamp of the last backup run in Unix format
next_run_at	Integer	Timestamp of the next scheduled backup run in Unix format
created_by	UUID	Identifier of the user who created the configuration
created_by_name	String	Display name of the user who created the configuration
encryption_key	String	Encryption key used to encrypt the backup files
s3_config	Object	S3 destination configuration, used when the destination is S3

---

info

• A valid Bearer Token is required to access this endpoint.
• The scopes array lists the data scopes included in the automatic backup. Supported scope codes are:
  • 1 = System Configuration
  • 2 = Keys
  • 3 = Audit Log
  • 4 = System Log
• The schedule.schedule_type determines how often the automatic backup runs:
  • 1 = Daily
  • 2 = Weekly — the weekly_days array specifies which days of the week the backup runs
  • 3 = Monthly — the monthly_dates array specifies which dates of the month the backup runs
• The weekly_days array uses the following codes:
  • 0 = Sunday
  • 1 = Monday
  • 2 = Tuesday
  • 3 = Wednesday
  • 4 = Thursday
  • 5 = Friday
  • 6 = Saturday
• The encryption_key is required to restore the encrypted backup files. Store it securely.
• The s3_config object is only populated when the destination_type is set to an S3 destination.
• Unix timestamp fields can be converted to a human-readable date and time format as needed.